/*
 * Copyright (C) 2024 Square, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package app.cash.redwood.snapshot.testing

import app.cash.burst.TestInterceptor
import app.cash.burst.coroutines.CoroutineTestInterceptor

/**
 * Captures snapshots of a subject view.
 *
 * The subject of the view hierarchy must do its own layout invalidation. This is particularly
 * important for iOS UIView layouts, where the application layer is responsible for tracking layout
 * changes.
 */
interface Snapshotter {
  suspend fun snapshot(
    name: String? = null,
    scrolling: Boolean = false,
  )

  /** This interface extends [TestInterceptor] for platforms that need it to get test metadata. */
  interface Factory<T : Any> : CoroutineTestInterceptor {
    operator fun invoke(widget: T): Snapshotter
  }
}
